home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / PInterfaces / QD3DSet.p < prev    next >
Encoding:
Text File  |  1997-08-12  |  11.4 KB  |  312 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        QD3DSet.p
  3.  
  4.      Contains:    Q3Set types and routines                                            
  5.  
  6.      Version:    Technology:    Quickdraw 3D 1.5.1
  7.                  Release:    Universal Interfaces 3.0.1
  8.  
  9.      Copyright:    © 1995-1997 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        Please include the the file and version information (from above) with
  12.                  the problem description.  Developers belonging to one of the Apple
  13.                  developer programs can submit bug reports to:
  14.  
  15.                      devsupport@apple.com
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT QD3DSet;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __QD3DSET__}
  28. {$SETC __QD3DSET__ := 1}
  29.  
  30. {$I+}
  31. {$SETC QD3DSetIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __QD3D__}
  35. {$I QD3D.p}
  36. {$ENDC}
  37.  
  38.  
  39. {$PUSH}
  40. {$ALIGN POWER}
  41. {$LibExport+}
  42.  
  43. {*****************************************************************************
  44.  **                                                                             **
  45.  **                                Set Routines                                 **
  46.  **                                                                             **
  47.  ****************************************************************************}
  48. FUNCTION Q3Set_New: TQ3SetObject; C;
  49. FUNCTION Q3Set_GetType(theSet: TQ3SetObject): LONGINT; C;
  50. FUNCTION Q3Set_Add(theSet: TQ3SetObject; theType: TQ3ElementType; data: UNIV Ptr): TQ3Status; C;
  51. FUNCTION Q3Set_Get(theSet: TQ3SetObject; theType: TQ3ElementType; data: UNIV Ptr): TQ3Status; C;
  52. FUNCTION Q3Set_Contains(theSet: TQ3SetObject; theType: TQ3ElementType): TQ3Boolean; C;
  53. FUNCTION Q3Set_Clear(theSet: TQ3SetObject; theType: TQ3ElementType): TQ3Status; C;
  54. FUNCTION Q3Set_Empty(target: TQ3SetObject): TQ3Status; C;
  55. {
  56.  *  Iterating through all elements in a set
  57.  *
  58.  *  Pass in kQ3ElementTypeNone to get first type
  59.  *  kQ3ElementTypeNone is returned when end of list is reached
  60.  }
  61. FUNCTION Q3Set_GetNextElementType(theSet: TQ3SetObject; VAR theType: TQ3ElementType): TQ3Status; C;
  62.  
  63. {*****************************************************************************
  64.  **                                                                             **
  65.  **                                Attribute Types                                 **
  66.  **                                                                             **
  67.  ****************************************************************************}
  68. { 
  69.  *    For the data types listed below, pass in a pointer to it in the _Add 
  70.  *    and _Get calls.
  71.  *
  72.  *    For surface shader attributes, reference counts are incremented on 
  73.  *    the _Add and _Get 
  74.  }
  75.  
  76. TYPE
  77.     TQ3AttributeTypes             = LONGINT;
  78. CONST
  79.                                                                 {  Data Type                 }
  80.     kQ3AttributeTypeNone        = {TQ3AttributeTypes}0;            {  ---------                 }
  81.     kQ3AttributeTypeSurfaceUV    = {TQ3AttributeTypes}1;            {  TQ3Param2D                 }
  82.     kQ3AttributeTypeShadingUV    = {TQ3AttributeTypes}2;            {  TQ3Param2D                  }
  83.     kQ3AttributeTypeNormal        = {TQ3AttributeTypes}3;            {  TQ3Vector3D                  }
  84.     kQ3AttributeTypeAmbientCoefficient = {TQ3AttributeTypes}4;    {  float                      }
  85.     kQ3AttributeTypeDiffuseColor = {TQ3AttributeTypes}5;        {  TQ3ColorRGB                 }
  86.     kQ3AttributeTypeSpecularColor = {TQ3AttributeTypes}6;        {  TQ3ColorRGB                 }
  87.     kQ3AttributeTypeSpecularControl = {TQ3AttributeTypes}7;        {  float                     }
  88.     kQ3AttributeTypeTransparencyColor = {TQ3AttributeTypes}8;    {  TQ3ColorRGB                 }
  89.     kQ3AttributeTypeSurfaceTangent = {TQ3AttributeTypes}9;        {  TQ3Tangent2D               }
  90.     kQ3AttributeTypeHighlightState = {TQ3AttributeTypes}10;        {  TQ3Switch                  }
  91.     kQ3AttributeTypeSurfaceShader = {TQ3AttributeTypes}11;        {  TQ3SurfaceShaderObject     }
  92.     kQ3AttributeTypeNumTypes    = {TQ3AttributeTypes}12;
  93.  
  94.  
  95. TYPE
  96.     TQ3AttributeType                    = TQ3ElementType;
  97. {*****************************************************************************
  98.  **                                                                             **
  99.  **                                Attribute Drawing                             **
  100.  **                                                                             **
  101.  ****************************************************************************}
  102. FUNCTION Q3Attribute_Submit(attributeType: TQ3AttributeType; data: UNIV Ptr; view: TQ3ViewObject): TQ3Status; C;
  103.  
  104. {*****************************************************************************
  105.  **                                                                             **
  106.  **                            AttributeSet Routines                             **
  107.  **                                                                             **
  108.  ****************************************************************************}
  109. FUNCTION Q3AttributeSet_New: TQ3AttributeSet; C;
  110. FUNCTION Q3AttributeSet_Add(attributeSet: TQ3AttributeSet; theType: TQ3AttributeType; data: UNIV Ptr): TQ3Status; C;
  111. FUNCTION Q3AttributeSet_Contains(attributeSet: TQ3AttributeSet; attributeType: TQ3AttributeType): TQ3Boolean; C;
  112. FUNCTION Q3AttributeSet_Get(attributeSet: TQ3AttributeSet; theType: TQ3AttributeType; data: UNIV Ptr): TQ3Status; C;
  113. FUNCTION Q3AttributeSet_Clear(attributeSet: TQ3AttributeSet; theType: TQ3AttributeType): TQ3Status; C;
  114. FUNCTION Q3AttributeSet_Empty(target: TQ3AttributeSet): TQ3Status; C;
  115. {
  116.  * Q3AttributeSet_GetNextAttributeType
  117.  *
  118.  * Pass in kQ3AttributeTypeNone to get first type
  119.  * kQ3AttributeTypeNone is returned when end of list is reached
  120.  }
  121. FUNCTION Q3AttributeSet_GetNextAttributeType(source: TQ3AttributeSet; VAR theType: TQ3AttributeType): TQ3Status; C;
  122. FUNCTION Q3AttributeSet_Submit(attributeSet: TQ3AttributeSet; view: TQ3ViewObject): TQ3Status; C;
  123. {
  124.  * Inherit from parent->child into result
  125.  *    Result attributes are:
  126.  *        all child attributes + all parent attributes NOT in the child
  127.  }
  128. FUNCTION Q3AttributeSet_Inherit(parent: TQ3AttributeSet; child: TQ3AttributeSet; result: TQ3AttributeSet): TQ3Status; C;
  129.  
  130. {*****************************************************************************
  131.  **                                                                             **
  132.  **                            Custom Element Registration                         **
  133.  **                                                                             **
  134.  ****************************************************************************}
  135. {
  136.  * Element Methods - 
  137.  *
  138.  *         When you create a custom element, you control what structures are 
  139.  *        passed around the API. For example, you may allow the Q3Set_Add call 
  140.  *        take one type of argument, store your element internally in some 
  141.  *        abstract data type, and have the Q3Set_Get call take a different 
  142.  *        argument.
  143.  *
  144.  *        For example:
  145.  *            
  146.  *        There are four calls which at some point will copy an element:
  147.  *
  148.  *        Q3Set_Add (copied from Application memory to QuickDraw3D memory)
  149.  *        Q3Set_Get (copied from QuickDraw3D memory to Application memory)
  150.  *        Q3Object_Duplicate (all elements are copied internally)
  151.  *        Q3AttributeSet_Inherit (all elements are copied internally)
  152.  *
  153.  *         Either CopyAdd or CopyReplace is called during the "_Add" call.
  154.  *            - CopyAdd is destructive and should assume "toElement" is garbage
  155.  *            - CopyReplace is replacing an existing element.
  156.  *
  157.  *         CopyGet is called during the "_Get" call.
  158.  *
  159.  *         CopyDuplicate is called to duplicate an element's internal structure.
  160.  *
  161.  * Attributes Methods - 
  162.  *
  163.  *        For copying data while Inheriting. Element methods are used
  164.  *        at all other times.
  165.  *    
  166.  *         CopyInherit is called to duplicate an element's internal structure 
  167.  *            during inheritance. You should make this as fast as possible.
  168.  *            (for example, if your custom element contains objects, you
  169.  *             should do a Q3Shared_GetReference instead of a Q3Object_Duplicate)
  170.  *            
  171.  *        The ElementDelete method will be called for all of your elements copied 
  172.  *        around via CopyAdd, CopyReplace, CopyDuplicate, and CopyInherit.
  173.  *        If CopyGet allocates any memory in it's destination, it is up to the app 
  174.  *        to delete it on its side.
  175.  }
  176.  
  177. TYPE
  178.     TQ3ElementCopyAddMethod = ProcPtr;  { FUNCTION TQ3ElementCopyAddMethod(fromAPIElement: UNIV Ptr; toInternalElement: UNIV Ptr): TQ3Status; C; }
  179.  
  180.     TQ3ElementCopyReplaceMethod = ProcPtr;  { FUNCTION TQ3ElementCopyReplaceMethod(fromAPIElement: UNIV Ptr; ontoInternalElement: UNIV Ptr): TQ3Status; C; }
  181.  
  182.     TQ3ElementCopyGetMethod = ProcPtr;  { FUNCTION TQ3ElementCopyGetMethod(fromInternalElement: UNIV Ptr; toAPIElement: UNIV Ptr): TQ3Status; C; }
  183.  
  184.     TQ3ElementCopyDuplicateMethod = ProcPtr;  { FUNCTION TQ3ElementCopyDuplicateMethod(fromInternalElement: UNIV Ptr; toInternalElement: UNIV Ptr): TQ3Status; C; }
  185.  
  186.     TQ3ElementDeleteMethod = ProcPtr;  { FUNCTION TQ3ElementDeleteMethod(internalElement: UNIV Ptr): TQ3Status; C; }
  187.  
  188. FUNCTION Q3ElementClass_Register(elementType: TQ3ElementType; name: ConstCStringPtr; sizeOfElement: LONGINT; metaHandler: TQ3MetaHandler): TQ3ObjectClass; C;
  189. FUNCTION Q3ElementType_GetElementSize(elementType: TQ3ElementType; VAR sizeOfElement: LONGINT): TQ3Status; C;
  190.  
  191. {*****************************************************************************
  192.  **                                                                             **
  193.  **                        Custom Attribute Registration                         **
  194.  **                                                                             **
  195.  ****************************************************************************}
  196.  
  197. TYPE
  198.     TQ3AttributeInheritMethod            = TQ3Boolean;
  199. { return kQ3True or kQ3False in your metahandler }
  200.     TQ3AttributeCopyInheritMethod = ProcPtr;  { FUNCTION TQ3AttributeCopyInheritMethod(fromInternalAttribute: UNIV Ptr; toInternalAttribute: UNIV Ptr): TQ3Status; C; }
  201.  
  202. FUNCTION Q3AttributeClass_Register(attributeType: TQ3AttributeType; creatorName: ConstCStringPtr; sizeOfElement: LONGINT; metaHandler: TQ3MetaHandler): TQ3ObjectClass; C;
  203. {
  204.  *    Version 1.1
  205.  }
  206.  
  207. TYPE
  208.     TQ3AttributeDefaultMethod = ProcPtr;  { FUNCTION TQ3AttributeDefaultMethod(internalElement: UNIV Ptr): TQ3Status; C; }
  209.  
  210.     TQ3AttributeIsDefaultMethod = ProcPtr;  { FUNCTION TQ3AttributeIsDefaultMethod(internalElement: UNIV Ptr): TQ3Boolean; C; }
  211.  
  212.  
  213.  
  214. CONST
  215.     kQ3XMethodTypeElementCopyAdd = 'ecpa';
  216.  
  217.  
  218. TYPE
  219.     TQ3XElementCopyAddMethod = ProcPtr;  { FUNCTION TQ3XElementCopyAddMethod(fromAPIElement: UNIV Ptr; toInternalElement: UNIV Ptr): TQ3Status; C; }
  220.  
  221.  
  222. CONST
  223.     kQ3XMethodTypeElementCopyReplace = 'ecpr';
  224.  
  225.  
  226. TYPE
  227.     TQ3XElementCopyReplaceMethod = ProcPtr;  { FUNCTION TQ3XElementCopyReplaceMethod(fromAPIElement: UNIV Ptr; ontoInternalElement: UNIV Ptr): TQ3Status; C; }
  228.  
  229.  
  230. CONST
  231.     kQ3XMethodTypeElementCopyGet = 'ecpg';
  232.  
  233.  
  234. TYPE
  235.     TQ3XElementCopyGetMethod = ProcPtr;  { FUNCTION TQ3XElementCopyGetMethod(fromInternalElement: UNIV Ptr; toAPIElement: UNIV Ptr): TQ3Status; C; }
  236.  
  237.  
  238. CONST
  239.     kQ3XMethodTypeElementCopyDuplicate = 'ecpd';
  240.  
  241.  
  242. TYPE
  243.     TQ3XElementCopyDuplicateMethod = ProcPtr;  { FUNCTION TQ3XElementCopyDuplicateMethod(fromInternalElement: UNIV Ptr; toInternalElement: UNIV Ptr): TQ3Status; C; }
  244.  
  245.  
  246. CONST
  247.     kQ3XMethodTypeElementDelete    = 'edel';
  248.  
  249.  
  250. TYPE
  251.     TQ3XElementDeleteMethod = ProcPtr;  { FUNCTION TQ3XElementDeleteMethod(internalElement: UNIV Ptr): TQ3Status; C; }
  252.  
  253. FUNCTION Q3XElementClass_Register(VAR elementType: TQ3ElementType; name: ConstCStringPtr; sizeOfElement: LONGINT; metaHandler: TQ3XMetaHandler): TQ3XObjectClass; C;
  254. FUNCTION Q3XElementType_GetElementSize(elementType: TQ3ElementType; VAR sizeOfElement: LONGINT): TQ3Status; C;
  255.  
  256. {*****************************************************************************
  257.  **                                                                             **
  258.  **                        Custom Attribute Registration                         **
  259.  **                                                                             **
  260.  ****************************************************************************}
  261.  
  262. CONST
  263.     kQ3XMethodTypeAttributeInherit = 'inht';
  264.  
  265.  
  266. TYPE
  267.     TQ3XAttributeInheritMethod            = TQ3Boolean;
  268. { return kQ3True or kQ3False in your metahandler }
  269.  
  270. CONST
  271.     kQ3XMethodTypeAttributeCopyInherit = 'acpi';
  272.  
  273.  
  274. TYPE
  275.     TQ3XAttributeCopyInheritMethod = ProcPtr;  { FUNCTION TQ3XAttributeCopyInheritMethod(fromInternalAttribute: UNIV Ptr; toInternalAttribute: UNIV Ptr): TQ3Status; C; }
  276.  
  277. FUNCTION Q3XAttributeClass_Register(VAR attributeType: TQ3AttributeType; creatorName: ConstCStringPtr; sizeOfElement: LONGINT; metaHandler: TQ3XMetaHandler): TQ3XObjectClass; C;
  278. {
  279.  *    Version 1.1
  280.  }
  281.  
  282. CONST
  283.     kQ3XMethodTypeAttributeDefault = 'asdf';
  284.  
  285.  
  286. TYPE
  287.     TQ3XAttributeDefaultMethod = ProcPtr;  { FUNCTION TQ3XAttributeDefaultMethod(internalElement: UNIV Ptr): TQ3Status; C; }
  288.  
  289.  
  290. CONST
  291.     kQ3XMethodTypeAttributeIsDefault = 'aidf';
  292.  
  293.  
  294. TYPE
  295.     TQ3XAttributeIsDefaultMethod = ProcPtr;  { FUNCTION TQ3XAttributeIsDefaultMethod(internalElement: UNIV Ptr): TQ3Boolean; C; }
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302. {$ALIGN RESET}
  303. {$POP}
  304.  
  305. {$SETC UsingIncludes := QD3DSetIncludes}
  306.  
  307. {$ENDC} {__QD3DSET__}
  308.  
  309. {$IFC NOT UsingIncludes}
  310.  END.
  311. {$ENDC}
  312.